home *** CD-ROM | disk | FTP | other *** search
/ IRIX 6.2 Development Libraries / SGI IRIX 6.2 Development Libraries.iso / dist / complib.idb / usr / share / catman / p_man / cat3 / complib / cgtrfs.z / cgtrfs
Text File  |  1996-03-14  |  5KB  |  199 lines

  1.  
  2.  
  3.  
  4. CCCCGGGGTTTTRRRRFFFFSSSS((((3333FFFF))))                                                          CCCCGGGGTTTTRRRRFFFFSSSS((((3333FFFF))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      CGTRFS - improve the computed solution to a system of linear equations
  10.      when the coefficient matrix is tridiagonal, and provides error bounds and
  11.      backward error estimates for the solution
  12.  
  13. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.      SUBROUTINE CGTRFS( TRANS, N, NRHS, DL, D, DU, DLF, DF, DUF, DU2, IPIV, B,
  15.                         LDB, X, LDX, FERR, BERR, WORK, RWORK, INFO )
  16.  
  17.          CHARACTER      TRANS
  18.  
  19.          INTEGER        INFO, LDB, LDX, N, NRHS
  20.  
  21.          INTEGER        IPIV( * )
  22.  
  23.          REAL           BERR( * ), FERR( * ), RWORK( * )
  24.  
  25.          COMPLEX        B( LDB, * ), D( * ), DF( * ), DL( * ), DLF( * ), DU( *
  26.                         ), DU2( * ), DUF( * ), WORK( * ), X( LDX, * )
  27.  
  28. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  29.      CGTRFS improves the computed solution to a system of linear equations
  30.      when the coefficient matrix is tridiagonal, and provides error bounds and
  31.      backward error estimates for the solution.
  32.  
  33.  
  34. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  35.      TRANS   (input) CHARACTER*1
  36.              Specifies the form of the system of equations:
  37.              = 'N':  A * X = B     (No transpose)
  38.              = 'T':  A**T * X = B  (Transpose)
  39.              = 'C':  A**H * X = B  (Conjugate transpose)
  40.  
  41.      N       (input) INTEGER
  42.              The order of the matrix A.  N >= 0.
  43.  
  44.      NRHS    (input) INTEGER
  45.              The number of right hand sides, i.e., the number of columns of
  46.              the matrix B.  NRHS >= 0.
  47.  
  48.      DL      (input) COMPLEX array, dimension (N-1)
  49.              The (n-1) subdiagonal elements of A.
  50.  
  51.      D       (input) COMPLEX array, dimension (N)
  52.              The diagonal elements of A.
  53.  
  54.      DU      (input) COMPLEX array, dimension (N-1)
  55.              The (n-1) superdiagonal elements of A.
  56.  
  57.      DLF     (input) COMPLEX array, dimension (N-1)
  58.              The (n-1) multipliers that define the matrix L from the LU
  59.              factorization of A as computed by CGTTRF.
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. CCCCGGGGTTTTRRRRFFFFSSSS((((3333FFFF))))                                                          CCCCGGGGTTTTRRRRFFFFSSSS((((3333FFFF))))
  71.  
  72.  
  73.  
  74.      DF      (input) COMPLEX array, dimension (N)
  75.              The n diagonal elements of the upper triangular matrix U from the
  76.              LU factorization of A.
  77.  
  78.      DUF     (input) COMPLEX array, dimension (N-1)
  79.              The (n-1) elements of the first superdiagonal of U.
  80.  
  81.      DU2     (input) COMPLEX array, dimension (N-2)
  82.              The (n-2) elements of the second superdiagonal of U.
  83.  
  84.      IPIV    (input) INTEGER array, dimension (N)
  85.              The pivot indices; for 1 <= i <= n, row i of the matrix was
  86.              interchanged with row IPIV(i).  IPIV(i) will always be either i
  87.              or i+1; IPIV(i) = i indicates a row interchange was not required.
  88.  
  89.      B       (input) COMPLEX array, dimension (LDB,NRHS)
  90.              The right hand side matrix B.
  91.  
  92.      LDB     (input) INTEGER
  93.              The leading dimension of the array B.  LDB >= max(1,N).
  94.  
  95.      X       (input/output) COMPLEX array, dimension (LDX,NRHS)
  96.              On entry, the solution matrix X, as computed by CGTTRS.  On exit,
  97.              the improved solution matrix X.
  98.  
  99.      LDX     (input) INTEGER
  100.              The leading dimension of the array X.  LDX >= max(1,N).
  101.  
  102.      FERR    (output) REAL array, dimension (NRHS)
  103.              The estimated forward error bound for each solution vector X(j)
  104.              (the j-th column of the solution matrix X).  If XTRUE is the true
  105.              solution corresponding to X(j), FERR(j) is an estimated upper
  106.              bound for the magnitude of the largest element in (X(j) - XTRUE)
  107.              divided by the magnitude of the largest element in X(j).  The
  108.              estimate is as reliable as the estimate for RCOND, and is almost
  109.              always a slight overestimate of the true error.
  110.  
  111.      BERR    (output) REAL array, dimension (NRHS)
  112.              The componentwise relative backward error of each solution vector
  113.              X(j) (i.e., the smallest relative change in any element of A or B
  114.              that makes X(j) an exact solution).
  115.  
  116.      WORK    (workspace) COMPLEX array, dimension (2*N)
  117.  
  118.      RWORK   (workspace) REAL array, dimension (N)
  119.  
  120.      INFO    (output) INTEGER
  121.              = 0:  successful exit
  122.              < 0:  if INFO = -i, the i-th argument had an illegal value
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. CCCCGGGGTTTTRRRRFFFFSSSS((((3333FFFF))))                                                          CCCCGGGGTTTTRRRRFFFFSSSS((((3333FFFF))))
  137.  
  138.  
  139.  
  140. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS
  141.      ITMAX is the maximum number of steps of iterative refinement.
  142.  
  143.  
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.